added header synopses to the reference #303
Conversation
|
An automated preview of the documentation is available at https://303.unordered.prtest2.cppalliance.org/libs/unordered/doc/html/index.html |
doc/modules/ROOT/pages/ref.adoc
Outdated
| * xref:reference/unordered_set.adoc[unordered_set] | ||
| * xref:reference/unordered_multiset.adoc[unordered_multiset] | ||
| * xref:reference/hash_traits.adoc[hash_traits] | ||
| * xref:reference/header_unordered_map_fwd.adoc[`<boost/unordered/unordered_map_fwd.hpp>` Synopsis] |
There was a problem hiding this comment.
Try putting the code backticks on the outside of the xref and tell me if you like how it looks.
In this image, the top two links are the updated version. The third one is the current look.
There was a problem hiding this comment.
I can solve this in a more satisfactory way, for that I'd need for you to add this definition to the source site.css:
.inlink-code {
font-family: Roboto Mono,monospace;
font-size: 95%;
color: inherit;
}
Can you do that?
There was a problem hiding this comment.
Of course. You can do that locally yourself even.
All you gotta clone is the unordered-ui-bundle repo and then invoke gulp bundle in it. There's docs here: https://gitlab.com/antora/antora-ui-default#user-content-development-quickstart
There was a problem hiding this comment.
I managed to do it without changing the CSS file: 191adf4.
|
I really like these changes but we'll probably have to update the UI bundle. Consider: The reference is awfully cramped here on my screen. I did a width adjustment in the CSS and this is how it looks now: Let me know what you think. It's kind of nice how much we can really fine tune here. |
|
An automated preview of the documentation is available at https://303.unordered.prtest2.cppalliance.org/libs/unordered/doc/html/index.html |
1 similar comment
|
An automated preview of the documentation is available at https://303.unordered.prtest2.cppalliance.org/libs/unordered/doc/html/index.html |
My concern with that is that less space is reserved for the actual content, and the whole page's width is constrained in boost.io. Is it possible to have the TOC's width be adjustable by the user by dragging its right border? |
Added header synopses to the reference in the style of the standard. Solves #301.